POST
/
v1
/
text2image
/
soul
Generate [Soul]
curl --request POST \
  --url https://platform.higgsfield.ai/v1/text2image/soul \
  --header 'Content-Type: application/json' \
  --header 'hf-api-key: <hf-api-key>' \
  --header 'hf-secret: <hf-secret>' \
  --data '{
  "webhook": {
    "url": "<string>",
    "secret": "<string>"
  },
  "params": {
    "prompt": "<string>",
    "width_and_height": "1152x2048",
    "enhance_prompt": false,
    "style_id": "464ea177-8d40-4940-8d9d-b438bab269c7",
    "style_strength": 1,
    "quality": "1080p",
    "seed": 500000,
    "custom_reference_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_reference_strength": 1,
    "image_reference": {
      "type": "<string>",
      "image_url": "<string>"
    },
    "batch_size": 1
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "text2image_soul",
  "created_at": "2023-11-07T05:31:56Z",
  "jobs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "job_set_type": "image2video",
      "status": "queued",
      "results": {
        "min": {
          "type": "<string>",
          "url": "<string>"
        },
        "raw": {
          "type": "<string>",
          "url": "<string>"
        }
      }
    }
  ],
  "input_params": {}
}

Headers

hf-api-key
string<uuid>
required
hf-secret
string
required

Body

application/json
params
object
required
webhook
object | null

Response

Successful Response

id
string<uuid>
required
type
enum<string>
required
Available options:
text2image_soul,
image2video
created_at
string<date-time>
required
jobs
Job · object[]
required
input_params
object
required